Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs/stacker_yaml.md #650

Merged

Conversation

mikemccracken
Copy link
Contributor

What type of PR is this?

documentation

Which issue does this PR fix:

  • reorganize stacker_yaml.md slightly for better readability

  • give more examples of valid urls for type 'tar', based on what the code supports.

  • clarify that the type: oci does not require that the url starts with oci:, in fact that will make it fail unless your oci layout is named oci, because in pkg/types/imagesource.go ContainersImageURL() prepends oci: to the url field of type: oci imagesource structs.

What does this PR do / Why do we need it:

updates docs

If an issue # is not available please add repro steps and logs showing the issue:

Testing done on this change:

you only live once

Automation added to e2e:
no

Will this break upgrades or downgrades?

no

Does this PR introduce any user-facing change?:

no

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

- reorganize slightly for better readability

- give more examples of valid urls for type 'tar', based on what the
code supports.

- clarify that the type: oci does not require that the url starts with
`oci:`, in fact that will make it fail unless your oci layout is named
`oci`, because in pkg/types/imagesource.go ContainersImageURL() prepends
`oci:` to the url field of type: oci imagesource structs.

Signed-off-by: Michael McCracken <mikmccra@cisco.com>
move the extensive commentary on substitution to the end, it was a bit
much to overexplain that right at the start, my bad.

add a basic common example stacker yaml right at the start so people
know what we are talking about.

Signed-off-by: Michael McCracken <mikmccra@cisco.com>
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.67%. Comparing base (46064c7) to head (0a37057).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #650      +/-   ##
==========================================
+ Coverage   54.00%   63.67%   +9.66%     
==========================================
  Files          57       57              
  Lines        6175     5018    -1157     
==========================================
- Hits         3335     3195     -140     
+ Misses       2194     1177    -1017     
  Partials      646      646              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hallyn hallyn merged commit ad9a694 into project-stacker:main Oct 29, 2024
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants